API Documentation
Sampler.h
1 // Sampler.h
3 //
5 
6 namespace nkGraphics
7 {
11  class DLL_GRAPHICS_EXPORT Sampler : public Resource, public nkExport::Exportable
12  {
13  public :
14 
18  Sampler () ;
22  virtual ~Sampler () ;
23 
24  // Getters
28  virtual FILTER getFiltering () const = 0 ;
32  virtual TEXTURE_ADDRESS_MODE getAddressModeU () const = 0 ;
36  virtual TEXTURE_ADDRESS_MODE getAddressModeV () const = 0 ;
40  virtual TEXTURE_ADDRESS_MODE getAddressModeW () const = 0 ;
44  virtual COMPARISON_FUNC getComparisonFunc () const = 0 ;
48  virtual float getMipBias () const = 0 ;
52  virtual unsigned int getMaxAnisotropy () const = 0 ;
56  virtual float getMinLodLevel () const = 0 ;
60  virtual float getMaxLodLevel () const = 0 ;
64  virtual float getBorderColorR () const = 0 ;
68  virtual float getBorderColorG () const = 0 ;
72  virtual float getBorderColorB () const = 0 ;
76  virtual float getBorderColorA () const = 0 ;
97 
98  // Setters
107  virtual void setBorderColors (float r, float g, float b, float a) = 0 ;
113  virtual void setBorderColorR (float value) = 0 ;
119  virtual void setBorderColorG (float value) = 0 ;
125  virtual void setBorderColorB (float value) = 0 ;
131  virtual void setBorderColorA (float value) = 0 ;
138  virtual void setLodLevels (float min, float max) = 0 ;
144  virtual void setMaxAnisotropy (unsigned int value) = 0 ;
150  virtual void setMipMapBias (float value) = 0 ;
156  virtual void setFilterMethod (FILTER value) = 0 ;
162  virtual void setAddressModeU (TEXTURE_ADDRESS_MODE value) = 0 ;
168  virtual void setAddressModeV (TEXTURE_ADDRESS_MODE value) = 0 ;
174  virtual void setAddressModeW (TEXTURE_ADDRESS_MODE value) = 0 ;
180  virtual void setComparisonFunc (COMPARISON_FUNC value) = 0 ;
184  virtual void resetToDefault () = 0 ;
215 
216  // Import / Export
222  virtual void exportClassToTree (nkExport::Node* rootNode) override ;
228  virtual void importClassFromTree (nkExport::Node* rootNode) override ;
229  } ;
230 }
nkGraphics::Sampler::setLodLevels
virtual void setLodLevels(float min, float max)=0
nkGraphics::Sampler::setAddressModeVFromString
void setAddressModeVFromString(const nkMemory::StringView &value)
nkGraphics::Sampler::getBorderColorG
virtual float getBorderColorG() const =0
nkGraphics::Sampler::setBorderColorB
virtual void setBorderColorB(float value)=0
nkGraphics::Sampler::setMipMapBias
virtual void setMipMapBias(float value)=0
nkGraphics::Sampler::getBorderColorB
virtual float getBorderColorB() const =0
nkGraphics::Sampler::getFilteringAsString
nkMemory::StringView getFilteringAsString() const
nkExport::Exportable
An interface to define objects that can be exported using this component.
Definition: Exportable.h:15
nkGraphics::Sampler::getAddressModeU
virtual TEXTURE_ADDRESS_MODE getAddressModeU() const =0
nkGraphics::Sampler::getAddressModeUAsString
nkMemory::StringView getAddressModeUAsString() const
nkGraphics::Sampler::setFilterMethod
virtual void setFilterMethod(FILTER value)=0
nkGraphics::Sampler::setComparisonFunc
virtual void setComparisonFunc(COMPARISON_FUNC value)=0
nkGraphics::Sampler::Sampler
Sampler()
nkGraphics::Sampler::getMipBias
virtual float getMipBias() const =0
nkGraphics::Sampler::setAddressModeU
virtual void setAddressModeU(TEXTURE_ADDRESS_MODE value)=0
nkGraphics::Sampler::setComparisonFuncFromString
void setComparisonFuncFromString(const nkMemory::StringView &value)
nkGraphics::Sampler::setBorderColorR
virtual void setBorderColorR(float value)=0
nkGraphics::Sampler::~Sampler
virtual ~Sampler()
nkGraphics::Sampler::getAddressModeW
virtual TEXTURE_ADDRESS_MODE getAddressModeW() const =0
nkGraphics::Sampler::setMaxAnisotropy
virtual void setMaxAnisotropy(unsigned int value)=0
nkGraphics::Sampler::getAddressModeV
virtual TEXTURE_ADDRESS_MODE getAddressModeV() const =0
nkGraphics::Sampler::getBorderColorA
virtual float getBorderColorA() const =0
nkGraphics::Sampler::resetToDefault
virtual void resetToDefault()=0
nkGraphics::Sampler::setAddressModeUFromString
void setAddressModeUFromString(const nkMemory::StringView &value)
nkExport::Node
A node in the tree structure representing the data to export / import.
Definition: Node.h:42
nkGraphics::Sampler::getMaxAnisotropy
virtual unsigned int getMaxAnisotropy() const =0
nkGraphics::Sampler::getBorderColorR
virtual float getBorderColorR() const =0
nkGraphics::Sampler::getAddressModeVAsString
nkMemory::StringView getAddressModeVAsString() const
nkMemory::StringView
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
nkGraphics::Sampler::setFilterMethodFromString
void setFilterMethodFromString(const nkMemory::StringView &value)
nkGraphics::Sampler::getMinLodLevel
virtual float getMinLodLevel() const =0
nkGraphics::Sampler
Holds all the information needed of a sampler used during rendering.
Definition: Sampler.h:12
nkGraphics::Sampler::getFiltering
virtual FILTER getFiltering() const =0
nkGraphics::Sampler::setAddressModeW
virtual void setAddressModeW(TEXTURE_ADDRESS_MODE value)=0
nkGraphics::Sampler::getMaxLodLevel
virtual float getMaxLodLevel() const =0
nkGraphics::Sampler::importClassFromTree
virtual void importClassFromTree(nkExport::Node *rootNode) override
nkGraphics::Resource
Base class for a resource in the component.
Definition: Resource.h:12
nkGraphics::Sampler::setBorderColorA
virtual void setBorderColorA(float value)=0
nkGraphics::TEXTURE_ADDRESS_MODE
TEXTURE_ADDRESS_MODE
Available texture addressing modes available for samplers.
Definition: DxDefinesWrapper.h:57
nkGraphics::FILTER
FILTER
Available filters available for samplers.
Definition: DxDefinesWrapper.h:13
nkGraphics::Sampler::getAddressModeWAsString
nkMemory::StringView getAddressModeWAsString() const
nkGraphics::COMPARISON_FUNC
COMPARISON_FUNC
Available comparison functions.
Definition: DxDefinesWrapper.h:70
nkGraphics::Sampler::setBorderColorG
virtual void setBorderColorG(float value)=0
nkGraphics::Sampler::setBorderColors
virtual void setBorderColors(float r, float g, float b, float a)=0
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7
nkGraphics::Sampler::exportClassToTree
virtual void exportClassToTree(nkExport::Node *rootNode) override
nkGraphics::Sampler::setAddressModeV
virtual void setAddressModeV(TEXTURE_ADDRESS_MODE value)=0
nkGraphics::Sampler::setAddressModeWFromString
void setAddressModeWFromString(const nkMemory::StringView &value)
nkGraphics::Sampler::getComparisonFunc
virtual COMPARISON_FUNC getComparisonFunc() const =0
nkGraphics::Sampler::getComparisonFuncAsString
nkMemory::StringView getComparisonFuncAsString() const